<!DOCTYPE html>
<html  >
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="keywords" content="teedoc, theme plugin, themes, plugin">
    <meta name="description" content="teedoc other plugins">
    <meta name="generator" content="teedoc">
    <meta name="markdown-generator" content="teedoc-plugin-markdown-parser">
        <link rel="stylesheet" href="/static/css/theme_default/prism.min.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/theme_default/dark.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/theme_default/light.css" type="text/css"/>
        <link rel="stylesheet" href="/static/css/custom.css" type="text/css"/>
        <script src="/static/js/theme_default/jquery.min.js"></script>
        <script src="/static/js/theme_default/pre_main.js"></script>
        <link rel="stylesheet" href="/static/css/search/style.css" type="text/css"/>
        <script>
var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://hm.baidu.com/hm.js?91ac08174b63c5c88f71f8a94004a1fe";
  var s = document.getElementsByTagName("script")[0]; 
  s.parentNode.insertBefore(hm, s);
})();
</script>
    <title>teedoc other plugins - teedoc</title>
</head>
<body>
    
            <div id="navbar">
                <div id="navbar_menu">
                    <a class="site_title" href="/en/"><img class="site_logo" src="/static/image/logo.png" alt="teedoc logo"><h2>teedoc</h2></a>
                    <a id="navbar_menu_btn"></a>
                </div>
                <div id="navbar_items">
                    <div>
                        <ul id="nav_left">
<li class="active"><a  href="/get_started/en/">Install</a></li>
<li class=""><a  href="/develop/en/">Develop</a></li>
</ul>

                    </div>
                    <div>
                        <ul id="nav_right">
<li class=""><a target="_blank" href="https://github.com/neutree/teedoc">github</a></li>
<li class="sub_items "><a  href="">语言: English</a><ul><li class=""><a  href="/get_started/zh/">中文</a></li>
<li class="active"><a  href="/get_started/en/">English</a></li>
</ul></li>
</ul>

                        <ul class="nav_plugins"><li><a id="themes" class="light"></a></li></ul><ul class="nav_plugins"><li><a id="search"><span class="icon"></span><span class="placeholder">Search</span>
                            <div id="search_hints">
                                <span id="search_input_hint">Keywords separated by space</span>
                                <span id="search_loading_hint">Loading, wait please ...</span>
                                <span id="search_download_err_hint">Download error, please check network and refresh again</span>
                                <span id="search_other_docs_result_hint">Result from other docs</span>
                                <span id="search_curr_doc_result_hint">Result from current doc</span>
                            </div></a></li></ul>
                    </div>
                </div>
            </div>
    
        <div id="wrapper">
            
            <div id="sidebar_wrapper">
                <div id="sidebar">
                    <div id="sidebar_title">
                        
                    </div>
                    <ul class="show">
<li class="not_active with_link"><a href="/get_started/en/index.html"><span class="label">Introduction to teedoc</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/install/index.html"><span class="label">Install teedoc</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/start.html"><span class="label">Start writing document</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/write_attention.html"><span class="label">Pay attention to when writing documents</span><span class=""></span></a></li>
<li class="active_parent with_link"><a href="/get_started/en/plugins/index.html"><span class="label">Plugin</span><span class="sub_indicator"></span></a><ul class="show">
<li class="not_active with_link"><a href="/get_started/en/plugins/themes.html"><span class="label">Theme Plugin</span><span class=""></span></a></li>
<li class="active with_link"><a href="/get_started/en/plugins/others.html"><span class="label">Other plugins</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/syntax/syntax_markdown.html"><span class="label">markdown syntax</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy.html"><span class="label">Deployment</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_github_pages.html"><span class="label">Deploy to github</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_nginx.html"><span class="label">Use nginx to deploy to the server</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/deploy_cdn.html"><span class="label">Use CDN to accelerate website</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/usage/seo.html"><span class="label">SEO (Optimize for Search Engines)</span><span class=""></span></a></li>
<li class="not_active with_link"><a href="/get_started/en/usage/sites.html"><span class="label">Website using teedoc</span><span class=""></span></a></li>
<li class="not_active no_link"><a><span class="label">More samples</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active no_link"><a><span class="label">Second-level subdirectory example</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active no_link"><a><span class="label">Sample three-level sub-directory</span><span class="sub_indicator sub_indicator_collapsed"></span></a><ul class="">
<li class="not_active with_link"><a href="/get_started/en/more/example_docs/doc1.html"><span class="label">Article 1</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="/get_started/en/more/example_docs/doc2.html"><span class="label">Article 2</span><span class=""></span></a></li>
</ul>
</li>
<li class="not_active with_link"><a href="https://github.com/teedoc/teedoc" target="_blank"><span class="label">This is a external link</span><span class=""></span></a></li>
</ul>
</li>
</ul>

                </div>
            </div>
            <div id="menu_wrapper">
                                    <div id="menu">
                                    </div>
                                </div>
            <div id="article">
                <div id="content_wrapper">
                    <div id="content_body">
                        <div id="article_title">
                            <h1>teedoc other plugins</h1>
                        </div>
                        <div id="article_tags">
                            <ul></ul>
                        </div>
                        <div id="article_content">
                            <h2 id="teedoc-plugin-markdown-parser-default-markdown-parsing-plugin"><code>teedoc-plugin-markdown-parser</code>: default markdown parsing plugin</h2>

<p>Configure the plugin in <code>site_config.json</code></p>

<pre><code class="json language-json">    "plugins": {
        "teedoc-plugin-markdown-parser":{
            "from": "pypi",
            "config": {
                "toc_depth": 3
            }
        },
    }
</code></pre>

<ul>
<li><code>toc_depth</code>: The depth of the article table of contents (right column), the default is <code>3</code>, which means to <code>h3</code> that is <code>### three-level heading</code> in <code>markdown</code></li>
</ul>

<h2 id="teedoc-plugin-search-website-search-plugin"><code>teedoc-plugin-search</code>: Website search plugin</h2>

<p>Let the website and documents support the search function, support the searched current document and the whole site search</p>

<p>To use, add to the <code>plugins</code> keyword in <code>site_config.json</code>:</p>

<pre><code class="json language-json">"plugins": {
    "teedoc-plugin-search":{
        "from": "pypi",
        "config": {
            "search_hint": "Search"
        }
    }
}
</code></pre>

<p>The prompt content of different documents can be configured in the corresponding document <code>config.json</code> to facilitate multi-language support (internationalization/i18n)</p>

<p>The supported configurations are as follows:</p>

<pre><code class="json language-json">"teedoc-plugin-search":{
    "config": {
        "search_hint": "Search",
        "input_hint": "Enter keywords, separate multiple keywords with spaces",
        "loading_hint": "Loading, please wait...",
        "download_err_hint": "Failed to download the file, please refresh and try again or check the network",
        "other_docs_result_hint": "Results from other documents",
        "curr_doc_result_hint": "Current document search result"
    }
}
</code></pre>

<ul>
<li><code>search_hint</code>: the prompt message of the search box (button), the default is <code>Search</code></li>
<li><code>input_hint</code>: input hint information in the search box of the search page, default <code>Keywords separated by space</code></li>
<li><code>loading_hint</code>: Load the file prompt for searching, the default is <code>Loading, wait please ...</code></li>
<li><code>download_err_hint</code>: The download of the file required for the search fails, the user needs to refresh the browser to try again or the network environment cannot download the file, the default is <code>Download error, please check network and refresh again</code></li>
<li><code>other_docs_result_hint</code>: search result hint, search result in other documents, default <code>Result from other docs</code></li>
<li><code>curr_doc_result_hint</code>: search result hint, the search result in the currently browsed document, default <code>Result from current doc</code></li>
</ul>

<h2 id="baidu-statistics">Baidu Statistics</h2>

<p>Add the code of <a href="https://tongji.baidu.com/">Baidu Statistics</a> on each page, send the visit information to Baidu, and you can see the visit statistics in the background</p>

<p>After registering and logging in to Baidu Statistics, add a website on the management page, and then there will be a code acquisition page with the following code</p>

<pre><code class="js language-js">&lt;script&gt;
var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://hm.baidu.com/hm.js?90c693aa2************c14a50bb49";
  var s = document.getElementsByTagName("script")[0];
  s.parentNode.insertBefore(hm, s);
})();
&lt;/script&gt;
</code></pre>

<p>Here is a string of keys <code>90c693aa2************c14a50bb49</code>, copy this string of keys, and then add to the <code>plugins</code> keyword in <code>site_config.json</code>:</p>

<pre><code class="json language-json">"plugins": {
    "teedoc-plugin-baidu-tongji":{
        "from": "pypi",
        "config": {
            "code": "Fill in the access key here"
        }
    }
}
</code></pre>

<p>After the website is deployed, you can see the visit information on the real-time visitor page of the Baidu statistics background</p>

                        </div>
                    </div>
                    <div id="previous_next">
                        <div id="previous">
                            <a href="/get_started/en/plugins/themes.html"><span class="icon"></span><span class="label">Theme Plugin</span></a>
                        </div>
                        <div id="next">
                            <a href="/get_started/en/syntax/syntax_markdown.html"><span class="label">markdown syntax</span><span class="icon"></span></a>
                        </div>
                    </div>
                </div>
                <div id="toc">
                    <div>
                        <ul>
  <li><a href="#teedoc-plugin-markdown-parser-default-markdown-parsing-plugin"><code>teedoc-plugin-markdown-parser</code>: default markdown parsing plugin</a></li>
  <li><a href="#teedoc-plugin-search-website-search-plugin"><code>teedoc-plugin-search</code>: Website search plugin</a></li>
  <li><a href="#baidu-statistics">Baidu Statistics</a></li>
</ul>

                    </div>
                </div>
            </div>
        </div>
        <a id="to_top" href="#"></a>
        <div id="doc_footer">
                        
            <div id="footer">
                <div id="footer_top">
                    <ul>
<li><a>Links</a><ul><li><a target="_blank" href="https://github.com/neutree/teedoc">Build with teedoc</a></li>
<li><a target="_blank" href="https://neucrack.com">Copyright © 2021 Neucrack</a></li>
<li><a  href="/sitemap.xml">Sitemap</a></li>
</ul>
</li>
<li><a>Source code</a><ul><li><a target="_blank" href="https://github.com/neutree/teedoc">github</a></li>
<li><a target="_blank" href="https://github.com/teedoc/teedoc.github.io">website source files</a></li>
</ul>
</li>
</ul>

                </div>
                <div id="footer_bottom">
                    <ul>
<li><a target="_blank" href="https://beian.miit.gov.cn">*ICP备********号-1</a></li>
<li><a target="_blank" href="https://beian.miit.gov.cn/#/Integrated/index">*公网安备**************号</a></li>
</ul>

                </div>
            </div>
                    </div>
</body>
<script src="/static/js/theme_default/main.js"></script>
<script src="/static/css/theme_default/prism.min.js"></script>
<script src="/static/js/custom.js"></script>
<script src="/static/js/search/main.js"></script>
</html>
